home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / graphics / vtools20.arj / VTOOLS.DOC < prev    next >
Text File  |  1994-02-09  |  43KB  |  1,202 lines

  1.  
  2.  
  3.  
  4.                       VIRTUAL REALITY TOOLS 2.0
  5.  
  6.                      With MCGA and VGA libraries
  7.  
  8.                   (c) Copyright 93/94 D.G. Sureau
  9.  
  10.                          For AT-286 or more
  11.                          512 KB  & VGA card
  12.  
  13.  
  14.  
  15.                     ┌─────────┐
  16.                     │ SUMMARY │
  17.                     └─────────┘
  18.        Overview.
  19.        Starting up VTools.
  20.        The VTools' desktop.
  21.        MegaSprites.
  22.        Automaton assembler.
  23.        Organizer.
  24.        Virtual tree editor.
  25.        Three-D Viewer.
  26.        Formats for sprites.
  27.        File formats.
  28.        Compatibility.
  29.  
  30.  
  31.  
  32. ┌──────────┐
  33. │ OVERVIEW │
  34. └──────────┘
  35.  
  36. Virtual  Reality  Tools is a set of utilities to create scenery
  37. and  animations for programs of the new generation. The current
  38. version  contains  sprite  editors,  an automaton assembler, an
  39. editor  of mathematical designed virtual trees, and other tools
  40. to facilitate work of programmers.
  41.  
  42. Here, summarized, what you can do with VTools:
  43. - drawing 16 or 256 colors sprites for VGA or SVGA.
  44. -  drawing icons and saving them in standard ICO files for Win-
  45. dows.
  46. -  rotating,  merging  images or parts of images, and therefore
  47. assembling objects in more complexes ones.
  48. - assembling sprites in automatons and viewing animations.
  49. - converting sprites from a format to another at the touch of a
  50. key.
  51. -  defining virtual trees and saving parameters in files usable
  52. by your own programs.
  53. -  displaying walls and objects in a 3D scenery to try them be-
  54. fore using in your programs.
  55. In the near future, other tools will be again added to this set
  56. with free update to registered users...
  57.  
  58.  
  59. ┌────────────────────┐
  60. │ STARTING UP VTOOLS │
  61. └────────────────────┘
  62.  
  63. From the DOS prompt, simply type:
  64.  
  65.   VTOOLS
  66.  
  67. or add to the name of a sprite file or an icon as parameter:
  68.   Ex: VTOOLS DEMO
  69.   Ex: VTOOLS VTOOLS.ICO
  70.  
  71. If  extension is not typed, the program search for a sprite fi-
  72. le.  In  all  cases but the present one, VTools sets itself the
  73. extensions  for  files,  that are proper to file type, and that
  74. user can't change.
  75. Once  the  sprites  loaded,  you  may  type '?' to view them or
  76. choose a tool with cursor keys and press ENTER to start it.
  77.  
  78.  
  79. ┌─────────────────────┐
  80. │ THE VTOOLS' DESKTOP │
  81. └─────────────────────┘
  82.  
  83. The  desktop  that appears when starting VTools is the disk in-
  84. terface. It allows to load and save files, and to choose a pro-
  85. gram.
  86. Each program of this software is represented by an icon and you
  87. also can see than icons are affected to each sprite file in the
  88. current directory, while they can fit in the available space on
  89. the screen... To click on an icon allows loading the file.
  90. As  a  general rule, commands and processes are similar to Win-
  91. dows'  standard  conventions that I have done to avoid users to
  92. learn several graphical interfaces.
  93.  
  94. The  software  can be used either with a mouse or with the key-
  95. board.  To  click on an object, is equivalent to select the ob-
  96. ject with cursor keys and press ENTER. Then, I shall say simply
  97. in this manual "click on the object" to execute or load the ob-
  98. ject, equally when one uses mouse or keyboard.
  99.  
  100. When  several functions can apply to an object, one clicks once
  101. to  select  the object, then one chooses a function in the menu
  102. or  one click again to apply it, or one clicks twice to execute
  103. the program or to load the file.
  104. The two mouse buttons equally can be used on menu or on command
  105. icons. In other cases, they have not identical effect.
  106. Sometimes  they have same function but the left button is for a
  107. single  act  while the right button is for continuous act while
  108. held  down.  Inside drawing windows they have not same function
  109. at all.
  110.  
  111.  
  112. The title bar
  113.  
  114. The  desktop  shows  on  the  title bar the name of the current
  115. sprite  file. The button at right of the menu bar is similar to
  116. the  ESC  key  for  the mouse, and allows to exit a process, to
  117. close  a  window,  or to quit VTools. The button at left of the
  118. title  bar is for displaying the copyright and the current ver-
  119. sion, and the shortcut key is 'h'.
  120.  
  121.  
  122. The menu bar
  123.  
  124. To  access menu, click on the menu bar or press ALT plus letter
  125. which is underlined, or press F10. Use cursor keys to select an
  126. option (up/down) or change sub-menu (left/right).
  127. Press ESC to exit a sub-menu, press ESC again to exit the menu.
  128. Here  are detailed commands in each sub-menu and their shortcut
  129. keys.
  130.  
  131. FILE
  132. Load work      l       Load previously saved work
  133.                CTRL+l  Load work saved by CTRL+s
  134. Save work      s       Save table of sprites, addresses, types,
  135.                        automaton board.
  136.                CTRL+s  Save addresses and sprite images in
  137.                        separated files.
  138. Directory      d       Open the directory window.
  139. Set dir mask   x       Choose files to be displayed.
  140. Set path       Home    Set drive and access path.
  141. Load icon      i       Load a Window's icon.
  142. Quit           q       Exit VTools.
  143.  
  144. SPRITES
  145. MegaSprites    M       256 colors sprite editor.
  146. Automaton      A       Automaton assembler.
  147. Organizer      O       Memory organizer.
  148. Virtual trees  F       Editor for virtual trees.
  149. Three-D view   T       Display sprites in 3D view.
  150. Display all    ?       Display sprites in memory.
  151.  
  152. PALETTE
  153. Change RGB      %      Change colors.
  154. Load pal+RGB    r      Load colors.
  155. Save pal+RGB    w      Save colors.
  156.  
  157. INFO
  158. Help            F1     Help screen.
  159. System          ~      Display formats, sizes, and so on...
  160. Internal        b      Display internal sprite buffer.
  161. Beeps on/off    -      Set/Reset sound.
  162. Colors          o      Dialog box for color preferences.
  163.  
  164. QUIT
  165. Quit           q       Exit VTools.
  166. Restart        y       Restart program with default values.
  167.                        That will not clear sprite buffer.
  168. Erase sprites  DEL     Erase all sprites in memory.
  169.  
  170. Other commands that are not in the menu:
  171. ENTER: execute an icon.
  172. ALT-F4, F3, ALT-x: Quit the program.
  173.  
  174.  
  175. Dialog box for confirmation
  176.  
  177. When  a box asks for a Y/N answer, press the left button inside
  178. the  box to respond 'Y', or click out of the box to say 'N' and
  179. cancel.  For security, one can't use mouse to respond, one must
  180. press the 'Y' or 'N' keys.
  181.  
  182.  
  183. The windows
  184.  
  185. Some windows can be moved and have variable size. In this case,
  186. there is a button at left on the title bar, with a 3D box insi-
  187. de.
  188. If  the window can be changed, press ALT-SPACE to enter editing
  189. mode,  and then you may use the cursor keys to move the window,
  190. or  hold  down  the ALT keys with the cursor keys to change the
  191. size. Alternate keys are +, -, <, > to change the size.
  192. Press ENTER or ESC to exit editing mode.
  193.  
  194. When  mouse is on the left or top border, the mouse pointer be-
  195. comes  a  four  arrows image, if the window can be moved. Press
  196. left mouse button and drag to move the window.
  197. When  mouse  is  on the right or bottom border, the pointer be-
  198. comes  a  horizontal  arrow if size or width can be changed. In
  199. the same manner, press left button and drag to change.
  200.  
  201. Press  the  right mouse button to exit the process, or click on
  202. the ESC button at the top of the screen.
  203.  
  204. To change the colors, press ALT-b for the background, ALT-h for
  205. the title bar.
  206.  
  207.  
  208. The directory
  209.  
  210. Press  'd' to display the current directory. It is displayed in
  211. a window having variable size.
  212. The  window  displays filenames in uppercase black letters, and
  213. sub-directories in lower case red letters.
  214. Click on a sub-directory to display it, click on '..' to return
  215. at previous level. Click on a disk icon or press the drive let-
  216. ter  (uppercases)  to change drive. Uses cursor keys or lift at
  217. right  of the window to select a file and to scroll. Note there
  218. are  two  buttons  at  extremities  of  the lift than serves to
  219. scroll a single line at once.
  220.  
  221. Click  on  a  sprite filename (.SPR) or icon filename (.ICO) to
  222. load it.
  223.  
  224. To change the window, press ALT-SPACE or click on borders.
  225.  
  226. Press ESC, or do a mouse click out of the window to close it.
  227.  
  228.  
  229. File masking
  230.  
  231. The  directory  display allows use of a combination of masks by
  232. file  type.  Press the 'x' key to open the dialogue box for the
  233. selection.
  234.  
  235. The types and extensions are as following:
  236. - Work:      Sprite files: SPR + WRK extensions.
  237. - Screens:   PCX, VRT, VGA files.
  238. - ICO:       Windows' icons.
  239. - All files: all files recognized by VTools including
  240.              the above files..
  241. - Directories: sub-directories.
  242.  
  243. Click  on  the  1...5  button or type the number to set/reset a
  244. mask. The program says 'YES', when files will be displayed.
  245. Press HOME to restore defaults.
  246. Press ENTER to close, or press 'd' to show the directory.
  247.  
  248.  
  249. To change drive and path
  250.  
  251. On  can set drive and path for files by a press on the 'p' key,
  252. and then by typing the drive letter and the path.
  253. Example:   A:\PIC
  254.  
  255.  
  256. Dialog box for loading and saving sprites
  257.  
  258. Loading  and  saving  are done with a dialogue box, opened when
  259. one  presses  'l' for loading, or 's' for saving (or CTRL-l and
  260. CTRL-s to have the adresses in a separated file).
  261.  
  262. There  is  three  fields, one for the drive, the second for the
  263. directory or path, and a field for the filename.
  264.  
  265. The dialogue box has a special built-in editor: use cursor keys
  266. up/down to change line, backspace or DEL key to delete letters,
  267. INS to toggle between insert/copy mode.
  268.  
  269. In this program, only the filename node is read by the program,
  270. if an extension is typed the program removes it and replaces it
  271. with SPR and WRK extension to save or to load the file.
  272. Don't  press ENTER when a line is filled, move to the following
  273. with  the vertical cursor keys, the program keeps the displayed
  274. data.  Press  ESC  to  abort or ENTER when all three fields are
  275. right, to access the file.
  276. If  previously,  one has loaded sprite by clicking on its icon,
  277. when  one wants to save the file, path and name are already ty-
  278. ped in the proper fields, only one has to press ENTER to save.
  279.  
  280. The  memory  buffer for the table of sprites has variable size,
  281. that  depends  of  the  available conventional memory, 640Kb or
  282. less.
  283. If you frequently change the size of memory by loading resident
  284. programs,  then avoid fully to fill up the memory buffer as the
  285. file  will  no longer fit in memory. If this occurs, you should
  286. have  a disk system to  boot which sets not these resident pro-
  287. grams.
  288.  
  289.  
  290. The palette windows (RGB registers)
  291.  
  292. The % command opens the window for RGB registers changing, that
  293. don't  affect the desktop's colors but those of the sprite edi-
  294. tors only. There are two buttons to select the previous or next
  295. colors and three bar to change the RGB registers.
  296. The registers are temporary affected to the color 9 to view the
  297. changes.
  298. This  window allows to set the registers by numerical value. As
  299. the  desktop  use the VGA 18 screen mode, it is not possible to
  300. display the colors one have sets beyond the 64 first ones.
  301. VGA  18  has  only 64 registers while MCGA has 256. However the
  302. current dialog box allows to change all the 256 colors and view
  303. them on the MegaSprites desktop.
  304. They  RGB  registers may also be changed within the MegaSprites
  305. program.
  306.  
  307.  
  308. The dialog box for colors
  309.  
  310. To  select  an item to change, use the vertical cursor keys. To
  311. select the color, use the horizontal cursor keys.
  312. All  these  colors are for the desktop but the input background
  313. and  text,  that  are for some fields to input or to display in
  314. the utilities.
  315. One  may  change  colors  of windows with the ALT-b key for the
  316. background and ALT-h for the title bar.
  317. These color are saved with the file of sprites.
  318.  
  319. ┌─────────────┐
  320. │ MEGASPRITES │
  321. └─────────────┘
  322.  
  323. Summary
  324.  
  325. Features of MegaSprites
  326. The MegaSprites' screen
  327. The most usual keyboard commands:
  328. Using the mouse in MegaSprites
  329. Selecting a color for brush, ellipse, fill area and others
  330. Drawing
  331. Editing
  332. Changing the palette
  333. To change a color in the whole drawing
  334. Painting and special effects
  335. Making a sprite
  336. Making a standard icon
  337. Making a sprite in ASCII files
  338. Viewing sprites in memory
  339. Problems
  340. Summary of keyboard commands in MegaSprites
  341.  
  342. Features of MegaSprites
  343.  
  344. Produces  256  or  16  colors sprites, compressed fast sprites,
  345. standard  icons  for  Windows (c), allows drawing with mouse or
  346. keyboard,  can  change size while editing, has simultaneous ma-
  347. gnifying  window,  creating palette, has rubber, ellipse, fill,
  348. rectangle,  spray, shading, mirror, rotation by one degree, re-
  349. placing a color in the image, insert/delete row or column, mer-
  350. ging images, cut and paste with rotation on the drawing or from
  351. a sprite to the drawing, stores until 1024 sprites in memory.
  352.  
  353.  
  354. The MegaSprites' screen
  355.  
  356. Images  are drawn inside the window in the middle of the screen
  357. and  zoomed  x  4 simultaneously in the window above. Width and
  358. height are displayed below the image.
  359. At  left,  the  "window  on the memory" shows sprites loaded or
  360. previously drawn and stored into the table. Number in the table
  361. is  below this window and available free space in memory is be-
  362. low the grey icons, that are for special effects.
  363. At right is the 256 colors palette and at top of the screen the
  364. palette for 16 colors sprites.
  365. Below,  the  three  colors red, green and blue are for creating
  366. colors for the palette.
  367. Below are indicators:
  368. -  at  left  the indicator for the brush up or down, nothing if
  369. brush is up and a filled rectangle if brush is down.
  370. - then is the rubber if rubber is on, otherwise nothing.
  371. - at right a triangle is shown when one gets a color to copy it
  372. elsewhere  in  the  palette, or there are two filled rectangles
  373. when one does a color change in the image.
  374.  
  375. Each  of the ten most usual functions has an icon at the bottom
  376. of the screen, that are from left to right:
  377. 1) get image from the memory to the drawing window.
  378. 2) clear the drawing.
  379. 3) filling.
  380. 4)  the  rabbit  and  the  hat,  symbolize the 'undo' function,
  381. that comes back to past and restore image as before last act.
  382. 5) cut and paste.
  383. 6) change a color in the whole image.
  384. 7) make a 32 x 32 icon from the image.
  385. 8) make a 256 colors sprite from the image.
  386. 9) make a compressed 16 colors sprite.
  387. 10) return to the desktop.
  388.  
  389. There  is  also  a  panel  for special effects or other drawing
  390. function:  shading,  rotating, brush width, ellipse, line, rec-
  391. tangle, spray...
  392.  
  393.  
  394. The most usual keyboard commands:
  395.  
  396. ┌─────────────────────────────────────────────────────┐
  397. │ cursor keys:     select a color.                    │
  398. │ space bar:       set the brush up or down.          │
  399. │ 0:               set the rubber on or off.          │
  400. │ numeric keypad:  move the drawing cursor.           │
  401. │ b or z:          create a 256 or 16 color sprite.   │
  402. │ i:               create an icon.                    │
  403. │ <,>,+,- :        change the size of the image.      │
  404. │ page up/down:    select a sprite in memory.         │
  405. │ g:               get a sprite from memory.          │
  406. │ /:               cut and paste.                     │
  407. │ c:               change a color in the drawing.     │
  408. │ u:               undo.                              │
  409. │ f:               fill.                              │
  410. │ ESC:             returns to the desktop.            │
  411. └─────────────────────────────────────────────────────┘
  412. The F1 key allows displaying usual commands while drawing.
  413.  
  414.  
  415. Using the mouse in MegaSprites
  416.  
  417. In the drawing window the mouse becomes a pencil. By a click of
  418. the  right  mouse  button,  one puts the cursor where the mouse
  419. pointer  is,  inside the window, without any change in the dra-
  420. wing.
  421. Left  mouse  button  is  used  to  draw, a pixel at the time or
  422. continuously when holding down the button.
  423.  
  424. Summarizing the mouse use in MegaSprites...
  425. In the central window:
  426. - press left button to draw.
  427. - press right button to put the cursor at a location.
  428.  
  429. In the upper magnifying window:
  430. - press left button to draw.
  431. -  press  right  button  to  get color according to that of the
  432. pixel pointed out by the mouse.
  433.  
  434. In the left window on memory:
  435. - press left button to view next sprite.
  436. - press right button to view the previous one.
  437.  
  438. In the palette area:
  439. press any mouse button to get the color.
  440.  
  441. On the bar of icons:
  442. press any mouse button to execute the command.
  443.  
  444.  
  445. Selecting a color for brush, ellipse, fill area and others
  446.  
  447. Use  cursor  keys  to move both in the 256 color palette and in
  448. the 16 color palette. The current color is designated by a rec-
  449. tangle above the palette.
  450. One  clicks  the  right mouse button on the color either in the
  451. palette or in the zoomed window to get the color.
  452.  
  453.  
  454. Drawing
  455.  
  456. First  put  the  brush  down  by a press on the space bar. When
  457. brush  is  down  a rectangle of current color appears above the
  458. palette.  In the same manners, the rubber is set on or off by a
  459. press on the '0' key.
  460. Use the numeric keypad to move the cursor on the drawing, or to
  461. draw if the brush or the rubber is down.
  462.  
  463. One can change the size of brush by a press on the '.' key.
  464. Two sizes are allowed.
  465.  
  466.  
  467. Editing
  468.  
  469. To edit the image, use these keys:
  470. CTRL-r   Insert a row of pixels at cursor location.
  471. CTRL-y   Delete the row.
  472. CTRL-o   Insert a column.
  473. CTRL-w   Delete the column.
  474.  
  475. <     reduce width (20 pixels min.).
  476. >     increase width (80 pixels max.).
  477. -     reduce height (20 pixels min.).
  478. +     increase height (80 pixels max.).
  479.  
  480. Mirror functions:
  481. ] or [   horizontal mirror.
  482. ~        vertical mirror.
  483.  
  484. Undo:
  485. One level undo is provided, type 'u' to restore the image. That
  486. clears the result of any function having general effect.
  487. You can type 'b' to save the drawing in the memory buffer, era-
  488. sing  it further is done at the touch of a key with the organi-
  489. zer.
  490.  
  491. To clear the window, type CTRL-z or DEL.
  492.  
  493.  
  494. Changing the palette
  495.  
  496. You  can  move  a  color from a number to another... Press 'o',
  497. this holds the current selected color, a triangle appears above
  498. the  palette,  move  now to a new location and press 'o' again,
  499. this drop the color and the triangle disappears.
  500.  
  501. You can change basis components of a color to create one...
  502. Above  the  palette  are  the basis components for colors: red,
  503. green  and  blue. One changes the current selected color by ad-
  504. ding or reducing of these inks. Click on the red, green or blue
  505. component  with left button to add to, with right button to re-
  506. duce this ink.
  507. With the keyboard, press R, G, B (uppercases) to add ink to the
  508. color, press ALT+r, ALT+g or ALT+b to reduce an ink.
  509.  
  510. The  palette  you create must allow inversion of color for some
  511. drawing  function, this supposes colors with complementary num-
  512. ber  (=complementary position in the palette) also have comple-
  513. mentary display, so complementary of a clear color must be dark
  514. and conversely...
  515.  
  516. The  palette  is saved in the WRK file, when sprites are saved,
  517. or separately with the 'w' command at the desktop.
  518.  
  519.  
  520. To change a color in the whole drawing
  521.  
  522. This changes all pixels of a color to another color.
  523.  
  524. Move the brush on a pixel having the color to be changed in the
  525. image, and then select a color in the palette for the replacing
  526. color, then  press 'c' to do the change.
  527. The  two  colors, are displayed above the palette. At left, the
  528. previous one, at right the new one.
  529. Press ENTER to do the change, or you can use cursor keys if you
  530. want  change the colors: up and down for the previous, left and
  531. right for the new.
  532.  
  533. With mouse, one selects the icon #5, one gets if needed old co-
  534. lor  with  left  button,  new  color  with right button and one
  535. clicks again on icon #5 to do the change.
  536.  
  537.  
  538. Painting and special effects
  539.  
  540. FILLING
  541. Select  first  the color, set the brush up, move the cursor in-
  542. side the area to fill, set the brush down, press 'f'.
  543.  
  544. Using mouse:
  545. 1) first get a color,
  546. 2)  set  the location inside the drawing, with right mouse but-
  547. ton.
  548. 3) click on the fill icon, the third.
  549.  
  550.  
  551. ELLIPSE/CIRCLE, RECTANGLE, LINE
  552. Select first the color for the object to draw.
  553. Type
  554. - 'e' to draw an ellipse or a circle,
  555. - 'r' for a rectangle,
  556. - 'l' for a line.
  557.  
  558. The location of the object if the current cursor location. This
  559. is  the  center  for an ellipse, the starting point for a line,
  560. the left bottom corner for a rectangle.
  561.  
  562. To  move the object, use the cursor keys or the left mouse but-
  563. ton.
  564. To  change  the  size,  use  the '4', '6', '8', '2' keys or the
  565. right mouse button. If a line, this changes the ending point.
  566.  
  567. Type  ENTER to draw the object according to the selected color,
  568. or  press  ESC  to  cancel. For the mouse, the get icon does an
  569. ENTER press.
  570.  
  571.  
  572. SPRAY
  573. Press 's' or click on the spray icon, the mouse pointer becomes
  574. a spray and so remains until you press again on the spray icon.
  575. When  the  mouse pointer is a spray, to click or to drag puts a
  576. set of pixels on the image rather than a single dot.
  577.  
  578.  
  579. SHADING
  580. -  choose  a row in the palette, it will be displayed at top in
  581. the 16 colors palette... The standard palette has at second row
  582. a  gray  gradation that is a good example for the shading func-
  583. tion.
  584. - move the cursor on a color in the image.
  585. -  press  'a'.  All areas with the chosen color have now grada-
  586. tion, according to the row of the palette...
  587. - press ALT-a to do shading from right to left.
  588.  
  589. MERGING IMAGES
  590. Press the '@' key to put the sprite in memory over the drawing.
  591. Press  the  '*'  key to do it according to the current rotation
  592. angle,  value of which being displayed below the window of dra-
  593. wing, at right.
  594.  
  595. To change this angle, type:
  596. F8               1 degree right.
  597. CTRL-F8          10 degrees right.
  598. ALT-F8           90 degrees right.
  599. F7               1 degree left.
  600. CTRL-F7          10 degrees left.
  601. ALT-F7           90 degrees left.
  602.  
  603.  
  604. CUT & PASTE
  605. This function is similar to the previous one, but it works with
  606. a part of the drawing, or a part of the sprite in memory.
  607. Press  '/' . A rectangle is outlined upon the sprite in memory.
  608. Press  the  TAB  key  to cut into the image or to return on the
  609. sprite in memory.
  610.  
  611. Use  <, >, +, - to change size, and the cursor keys to move the
  612. outlined rectangle.
  613. Or put left mouse button down and drag to move and right button
  614. to change size.
  615. Now press ENTER or click on the first icon at bottom of screen.
  616. The  cut  part of the image is now displayed inside the drawing
  617. window, by inverting the colors...
  618. Remember  than  if colors are not complementary in the palette,
  619. you see nothing.
  620.  
  621. Now you can change the angle of rotation if you want.
  622. - press a key of the numeric pad.
  623. - or press +, - to change a single degree.
  624. - or press < or > to change 10 degrees.
  625. - or use same keys as for the previous function.
  626. With  mouse, click on the icons that represent curved arrows at
  627. left, to change the angle.
  628.  
  629. The  cursor  keys  or the left mouse button held down, allow to
  630. move the part of image.
  631.  
  632. Press  ENTER  to paste or click on the icon #1 at the bottom of
  633. screen.
  634.  
  635.  
  636. Making a sprite
  637.  
  638. Various  kind  of sprites can be made from drawing according to
  639. following commands:
  640.  
  641. b         256 colors sprite.
  642. z         Z-RLE compressed 16 colors sprite.
  643. k         16 colors sprite (Size in memory is reduced by half
  644.           in relation to 256 colors sprite). As above, but no
  645.           compressed.
  646.  
  647. When  making  any  16 color sprite or icon, the image must have
  648. colors  of  a same row in the palette. The sprite has colors of
  649. the  row of palette you select at the time you made it, not the
  650. colors  you  use  when drawing it... The first color in this 16
  651. colors palette is always the black background color.
  652.  
  653. A  16  colors  sprite  must  have even number of columns as two
  654. pixels  are  stored into one byte. The program sets the correct
  655. number of columns.
  656.  
  657.  
  658. Making a standard icon
  659.  
  660. When you want to create an icon for Windows, you must first set
  661. the proper 32 x 32 pixels size.
  662. Use  the  '<'  key  to  reduce  the width and '-' to reduce the
  663. height, then draw the image.
  664. The  black  color is a part of the displayed image, to make the
  665. background,  use any color that is not in the first row at bot-
  666. tom of the palette.
  667. To  create the ICO file, press 'i', then give a 8 letters name,
  668. without extension, and press ENTER.
  669. The  image will also be stored as a k sprite to be further edi-
  670. ted.
  671.  
  672. Making a sprite in ASCII file
  673.  
  674. Type  'j'  and  give  a  8 letters name, without extension, and
  675. press ENTER.
  676. The  program will create a text file having ASC extension, that
  677. holds a 16 color sprite, that you may insert directly into your
  678. programs.  The  syntax  of the array is for the C language, but
  679. you may be easily edit it to another one.
  680. This command also makes an icon and a k sprite.
  681.  
  682.  
  683. Viewing sprites in memory
  684.  
  685. The  window  at  left shows sprites in memory, one uses PAGE UP
  686. and PAGE DOWN to select next or previous one in memory.  Or one
  687. puts  the  mouse  pointer into this window and presses the left
  688. button  to view the next sprite or the right button to view the
  689. previous one.
  690.  
  691. Type  'g'  to copy the sprite from memory to the window of dra-
  692. wing.
  693. To  compare  the  images,  type @ to put one over the other and
  694. type u to restore the drawing.
  695. The Organizer displays full description of each sprite in memo-
  696. ry.
  697.  
  698. Problems
  699.  
  700. UNDO exists. Type 'u' to restore image as before the last act.
  701.  
  702. BLACK SCREEN
  703. If  you  load a previous work and the WRK file has been corrup-
  704. ted,  the  color  registers  can be erased, type 'y' to restore
  705. standard palette, or load a previously saved palette.
  706.  
  707. NO ELLIPSE, RECTANGLE, LINE, PASTE...
  708. The  ellipse  starts with color complementary to background co-
  709. lor, if background has color 0, and is black, complementary co-
  710. lor is 255, and if it is black also, you see nothing. This pro-
  711. blem  disappears by making a palette with complementary colors,
  712. that is generally the case when using gradation.
  713.  
  714. COLORS OF SPRITE...
  715. Remember than when ones makes a 16 colors sprite with MegaSpri-
  716. tes,  colors  of  the sprites are those or current 16 color pa-
  717. lette (at top of screen), not colors used when drawing. This is
  718. a voluntary feature that allows to use different sets of colors
  719. with a same drawing...
  720.  
  721. WIDTH OF SPRITES...
  722. The  16 color sprites must have even width. The program automa-
  723. tically corrects that and add a column if needed.
  724.  
  725. WORK CAN'T BE LOADED
  726. This  can occurs if you save sprites with CTRL-s (addresses and
  727. raw  data  in separated files) and then load file with 'l' (ad-
  728. dresses  and  raw  data  in same file). Remember 'l' matches s,
  729. CTRL-l matches CTRL-s.
  730.  
  731. CTRL-c  The control-c interrupt is disabled, however some mouse
  732. drivers can thwart that, so try to avoid type that.
  733.  
  734.  
  735. Summary of keyboard commands in MegaSprites
  736.  
  737. Be  careful  to upper and lower cases. Keyboard is set in small
  738. letters state at start.
  739.  
  740. F1 or h          Help screen.
  741. ESCAPE, q        Return to desktop.
  742. cursor keys      Select a color.
  743. space bar        Brush up or down.
  744. 0                Rubber or brush.
  745. .                Change size of the brush.
  746. numeric keypad   Moving the brush on the drawing.
  747. HOME             Move to lower left in the drawing window.
  748. END              Move to upper right in the drawing window.
  749. u                Undo, restore the previous state.
  750.  
  751. PAGE UP/DOWN     Select a sprite in memory.
  752. CTRL-HOME        View first sprite in memory.
  753. CTRL-END         View last sprite in memory.
  754. g                Get displayed sprite.
  755. #                Put sprite in memory over the drawn image.
  756. *                Put sprite over image with current rotation.
  757. /                Cut and paste with rotation.
  758.  
  759. b                Make a 256 colors sprite.
  760. z                Make a compressed 16 colors sprite.
  761. k                Make a 16 colors sprite.
  762. i                Both stores image in table in 16 color format
  763.                  and writes it in an ICO file.
  764. j                Same as 'i' but saves again the image in an
  765.                  ASCII file.
  766.  
  767. CTRL-r           Insert a row of pixels.
  768. CTRL-y           Delete a row.
  769. CTRL-o           Insert a column.
  770. CTRL-w           Delete a column.
  771. CTRL-z or DEL    Erase image, clear the window.
  772. <                Reduce width by one column.
  773. >                Increase width.
  774. +                Reduce height by one row.
  775. -                Increase height.
  776.  
  777.  
  778. o                Copy a color to another location in the
  779.                  palette.
  780. c                Perform replacement of a color in the whole
  781.                  image.
  782. f                Fill area of same color, with current selected
  783.                  color.
  784.  
  785. R                Add red in current color.
  786. G                Add green.
  787. B                Add blue.
  788. ALT+r            Reduce red in current color.
  789. ALT+g            Reduce green.
  790. ALT+b            Reduce blue.
  791. y                Restore standard palette.
  792.  
  793. ] [              Horizontally reverses the image.
  794. ~                Vertically reverses the image.
  795. e                Draw an ellipse.
  796. r                Draw a rectangle.
  797. l                Draw a line.
  798. a                Shading for areas of a same color.
  799. ALT-a            Reverse shading.
  800.  
  801. F8               1 degree right for * command.
  802. CTRL-F8          10 degrees right.
  803. ALT-F8           90 degrees right.
  804. F7               1 degree left.
  805. CTRL-F7          10 degrees left.
  806. ALT-F7           90 degrees left.
  807.  
  808. A                Goes to the assembler of automaton.
  809. O                Goes to the organizer.
  810. T                Goes to Three-D Viewer.
  811. F                Goes to virtual tree editor.
  812. ALT-CTRL-b       Set the background to the current color.
  813.  
  814. ┌─────────────────────────────┐
  815. │ THE ASSEMBLER OF AUTOMATONS │
  816. └─────────────────────────────┘
  817.  
  818. An  automaton  is a sequence of sprites that composes an anima-
  819. tion. This assembler eases to make automatons and to try them.
  820.  
  821. The  board that graphically shows automatons, and that is saved
  822. with  the sprites, can hold many automatons, that can be easily
  823. edited  and combined. On this board, an automaton is a sequence
  824. of  ellipses  with number inside them, ordered by arrows. These
  825. numbers are numbers of the sprites in memory.
  826.  
  827. Animation  can  be  shown  in  the  window at the middle of the
  828. screen, or in full screen with VGA 19. At right of this window,
  829. nine  symbol  represent different available links. At right are
  830. shown the sprites in memory.
  831.  
  832. To  execute  a  sequence,  press  'i' or 'z' to view it in full
  833. screen.  The interpreter reads on the board from left to right.
  834. It  can  go up or down, but it respects following priorities if
  835. several  arrows  start  of  the  same  ellipse: right, then up,
  836. otherwise down.
  837.  
  838.  
  839. Making and editing automaton
  840.  
  841. One  selects a sprite in memory with PAGE UP/DOWN keys, and one
  842. presses ENTER to put an ellipse at cursor location, holding its
  843. number.
  844.  
  845. The keys to put arrows are these:
  846. 0: a horizontal line, the symbol to go right.
  847. 5: a vertical line, to go up or down.
  848. 1, 3, 7, 9: symbols to change direction.
  849. 2,  6, 8: add '>' to the lines, that is for better comprehensi-
  850. bility but have no utility for the interpreter.
  851.  
  852. The DEL key erases an ellipse.
  853.  
  854. To  save an automaton, move the cursor at the first ellipse and
  855. press  'w'. To load it, move the cursor at a location and press
  856. 'r'.
  857.  
  858.  
  859. Using a mouse
  860.  
  861. The mouse pointer becomes a pencil when it is over the board of
  862. automatons,  it  becomes  a  cross if one selects a link symbol
  863. otherwise it holds a sprite number.
  864. To get a symbol, click on a displayed symbol in the command pa-
  865. nel,  and  click on the sprite in memory to get the sprite num-
  866. ber, or anywhere on the command panel.
  867.  
  868. On  the  board,  click the left mouse button to drop an object,
  869. the right button to put only the cursor at a location.
  870.  
  871. The horizontal lift allows to scroll the board of automatons.
  872.  
  873. To change the sprite, click on the PAGE UP/DOWN keys at left of
  874. sprite  in  memory, with left button to scroll one at the time,
  875. right button to a fast scroll.
  876.  
  877.  
  878. Keyboard commands of the assembler
  879.  
  880. F1      Help screen.
  881. PAGES   Select a sprite in memory.
  882. Cursor keys Move to a location on the board.
  883. 0..9    Put a symbol at cursor location.
  884. ENTER   Put an ellipse on the board.
  885. DEL     Erase current cursor position
  886. x       Clear the whole board.
  887. i       Interpret the automaton and animate it. Move first
  888.         the cursor at start of the sequence.
  889. z       Run the automaton in VGA 19, 256 colors.
  890. m       Execute step by step the automaton.
  891. r       Read an automaton, displays it starting at current
  892.         cursor position.
  893. w       Write an automaton in a file, starting at cursor.
  894. #       Put/Remove the grid.
  895. n       Refresh the screen.
  896. HOME    Go to the start of the board.
  897. END     Go to the end of the board
  898. <       Scroll the board 20 columns left.
  899. >       Scroll the board 20 columns right.
  900. +       Slow down the animation.
  901. -       Speed up the animation.
  902. p       Switch between editor palette or standard one.
  903. ALT-b   Change the panel command color.
  904. ALT-j   Change the board color.
  905. ALT-n   Change the text and line color.
  906. ALT-o   Change the border.
  907. O       Organiser.
  908. M       MegaSprites.
  909. T       Three-D viewer.
  910. F       Virtual tree editor.
  911. q       Return to desktop.
  912.  
  913. Automatons  are saved in files with the AUT extension, that the
  914. program adds to itself. The board is saved into the WRK file.
  915.  
  916. ┌────────────────┐
  917. │ THE ORGANIZER  │
  918. └────────────────┘
  919.  
  920. This  utility  allows to change order of sprites in memory, de-
  921. lete  one, convert the format, display the detailed description
  922. and test the integrity.
  923.  
  924.  
  925. Keyboard commands of the organiser
  926.  
  927. PAGES   Select a sprite in memory.
  928. HOME    Go to the first sprite in memory.
  929. END     Go to the last sprite in memory.
  930. m       Go to the move mode. Use PAGE UP/DOWN to select a
  931.         new location, press ENTER to move or ESC to cancel.
  932. DEL     Delete displayed sprite.
  933. t       Change current format for converting.
  934. !       Convert displayed sprite to current format, and
  935.         replace it.
  936. b       Display x 4 a Z-RLE sprite.
  937. z       Display on VGA 19 screen, if format is compatible.
  938. p       Switch between editor palette or standard one.
  939. A       Assembler.
  940. M       MegaSprites.
  941. T       Three-D Viewer.
  942. F       Virtual Tree Editor.
  943. Q, ESC  Return to desktop.
  944.  
  945. ┌─────────────────────────────┐
  946. │ THE EDITOR OF VIRTUAL TREES │
  947. └─────────────────────────────┘
  948.  
  949. Why  get tired to draw landscapes when the computer can do most
  950. of  the  work?  This  program  mathematically calculate form of
  951. trees and paint them on the screen.
  952. Their parameters are saved in a 16 bytes file that the user can
  953. display, with the tree function, in its programs.
  954. Defining all the trees of a forest or a golf ground can be done
  955. with a single k. byte of data.
  956.  
  957. In  the  editor, there are commands to change sizes and command
  958. to change characteristics of trees.
  959. In  a general manner, one use lowercases to reduce a parameter,
  960. and uppercases to increase it, for command that have a horizon-
  961. tal lift on the panel.
  962.  
  963. Press F1 for help screen.
  964. Press ? to know numerical values of parameters.
  965. To speed up the changes on bars, type a number, from 1 to 9.
  966.  
  967. Commands for sizes:
  968. s     size of the whole tree.
  969. r     random number to determine the whole tree.
  970. t     height of the trunk.
  971. u     length of the branches.
  972. w     width of trunk and branches.
  973.  
  974. Commands for characteristics:
  975. l     drawing leaves or not.
  976. b     branching or not for the trunk.
  977. m     multiple branches at same level or not.
  978. h     straight trunk or not.
  979. f     fractal characteristic: branches have same
  980.       form than the trunk.
  981. c     conical form.
  982.  
  983. The  trunk can be gray or brown (n), leaves are green or snowed
  984. (v).
  985.  
  986. To  save  parameters,  type  'p', then give a name, the program
  987. adds  to the TRE extension. To load a tree, press 'g' and gives
  988. the name without extension.
  989.  
  990.  
  991. ┌────────────────────┐
  992. │ THE THREE-D VIEWER │
  993. └────────────────────┘
  994.  
  995. This  utilities  allows  to display the objects you create with
  996. MegaSprites in a Three-D view.
  997. I  you  are a registered user, you are provided a object module
  998. to  add the function to your program, and also you are provided
  999. the source in C standard language of the algo that make this 3D
  1000. maze  you  see  in the new games that come on the market in the
  1001. last  year.  The algo is short, and the beauty of this routine,
  1002. is  as  for  the  fractal threes, you paint only one image, and
  1003. have  it  reproduced  on  all the walls of the virtual city the
  1004. algo draws.
  1005. This  speed however is not that of these programs you have seen
  1006. for  the  reason  the  present program don't use look-up tables
  1007. that  store  the  result  of calculations. These tables require
  1008. more  than 100Kb and may not be included with the editors. They
  1009. should  also be rewritten when one changes the size of the sce-
  1010. nery.
  1011.  
  1012. In this unregistered version, size of the sprites is limited to
  1013. 80  x 80 that is not sufficient for the walls, and so a special
  1014. version  of MegaSprites is provided with the registered version
  1015. that  is  the same program, with a 16 color palette and a 160 x
  1016. 160  drawing window. The Screen Maker program provided with the
  1017. registered  version also allows to import pictures having until
  1018. 320x200 pixels.
  1019.  
  1020. The  bar of icons at bottom display these function from left to
  1021. right:
  1022. 1) Set the corridor view.
  1023. 2) Set the front wall view.
  1024. 3) Get the previous image.
  1025. 4) Get the next image.
  1026. 5) - 8) Change the size.
  1027. 9) Go to MegaSprites.
  1028. 10) Return to the desktop.
  1029.  
  1030. Above  the  bar  of icon is an indicator that shows if the view
  1031. display an image or only the structure of scenery.
  1032. If  you  wish  to change the size of the scenery, set first the
  1033. view  to  the green lines for faster display. That be done by a
  1034. click on the indicator.
  1035.  
  1036. Summary of commands:
  1037.  
  1038. g        Get the image to the view.
  1039. DEL      Remove the image from the view.
  1040. e        Set the corridor view.
  1041. f        Set the front panel view.
  1042. PAGE UP  Newt image.
  1043. PAGE DOWN Previous image.
  1044. <        Reduce the width.
  1045. >        Increase the width.
  1046. -        Reduce the height.
  1047. +        Increase the height.
  1048. M        Go to MegaSprites.
  1049. ESC      Return to the desktop.
  1050.  
  1051.  
  1052. ┌─────────────────────┐
  1053. │ FORMATS FOR SPRITES │
  1054. └─────────────────────┘
  1055.  
  1056. All  formats  but  MS are for displaying sprites from bottom to
  1057. top of screen.
  1058. Coordinate of sprite, but special F and EAS, are
  1059. - 0..639 x 0..479 on VGA 18 and SVGA,
  1060. - 0..319 x 0..199 on VGA 19.
  1061. Size  is  limited only by editors, 80 x 80 with MegaSprites and
  1062. VGA 18 sprite editor, 320 x 200 with Screen Maker.
  1063.  
  1064. Encoding  use  either  bitmap: 16, 256, Z16 or bit planes: F16,
  1065. MS,  EAS.  Bit planes encoding displays very fast on VGA 18 (or
  1066. VGA  16-EGA) screen resolution. Bitmap is an universal encoding
  1067. that displays on MCGA, VGA, SVGA with appropriate functions.
  1068. Principle of bitmap is to store all bits of a pixel into a byte
  1069. of  memory,  while  bit  planes encoding stores image by screen
  1070. planes.
  1071.  
  1072.  
  1073. The 256 colors format.
  1074.  
  1075. It's  a  universal  format  to display sprites with all VGA and
  1076. SVGA screen modes. Each pixel is coded with one byte, according
  1077. to the bitmap encoding.
  1078. In VGA 19 these sprites can be displayed very fast.
  1079.  
  1080.  Header:
  1081.  Byte 0: height, from 1 to 200.
  1082.  Byte 1: unused
  1083.  Byte 2-3: width from 1 to 320.
  1084.  Byte 4: format code 1.
  1085.  Byte 5: unused
  1086.  
  1087.  
  1088. The 16 colors format.
  1089.  
  1090. A universal format for VGA and SVGA. No compressed. The palette
  1091. number  allows  on  256 color screen to display the same sprite
  1092. with  different  sets of colors. It uses bitmap encoding with a
  1093. byte holding two pixels.
  1094.  
  1095.  Header:
  1096.  Byte 0:   height, from 1 to 200.
  1097.  Byte 1:   unused
  1098.  Byte 2-3: width from 1 to 320.
  1099.  Byte 4:   format code 5.
  1100.  Byte 5:   palette row number.
  1101.  
  1102. The 16 colors Z-RLE format.
  1103.  
  1104. A universal format for VGA and SVGA. Image is coded with an RLE
  1105. compression  algorithm  that  allows  a  display with same fast
  1106. speed than no compressed sprite. Compression can divide size by
  1107. 5  or  more,  depending of complexity of the image. The palette
  1108. number allows on 256 color screen to display a same sprite with
  1109. different sets of colors. Use bitmap encoding.
  1110.  
  1111. Header: as above, with format code 4.
  1112.  
  1113. The F16 (fast) format.
  1114.  
  1115. It  is  a  format  for VGA 18, that displays sprites very fast,
  1116. with  no  boundary,  so horizontal coordinate is in range 0..79
  1117. and not 0..639. Use bit planes encoding.
  1118.  
  1119.  Header:
  1120.  Byte 0:   height, from 1 to 200.
  1121.  Byte 1:   unused
  1122.  Byte 2-3: width from 1 to 80.
  1123.  Byte 4:   format code 6.
  1124.  Byte 5:   unused.
  1125.  
  1126. The EAS (Easy) format.
  1127.  
  1128. This  format  allows  to  make  sprite  with variable number of
  1129. screen  pages, from 1 to 4, and so displaying animation without
  1130. erasing background. Uses bit planes encoding.
  1131.  Header:
  1132.  Byte 0:   height, from 1 to 200.
  1133.  Byte 1:   unused
  1134.  Byte 2-3: width from 1 to 80.
  1135.  Byte 4:   format code 3.
  1136.  Byte 5:   unused.
  1137.  
  1138.  
  1139. MS
  1140.  
  1141. Format to display sprites from top to bottom of screen. It uses
  1142. bit planes encoding.
  1143.  Header:
  1144.  Byte 0: height, from 1 to 200.
  1145.  Byte 1: unused
  1146.  Byte 2-3: width from 1 to 320.
  1147.  Byte 4: format code 2.
  1148.  Byte 5: unused.
  1149.  
  1150.  
  1151. Icons.
  1152.  
  1153. When  icons are packed in a single file, they use the 256 or 16
  1154. colors format or compressed Z-RLE format.
  1155. They also can be saved into an ICO file with Windows' format.
  1156. Functions of the library in the registered version that display
  1157. icons  use  color 9 as background color and don't put it on the
  1158. screen, that is for rather display the 0 color that corresponds
  1159. to the most useful black color.
  1160.  
  1161.  
  1162. ┌────────────────┐
  1163. │  FILE FORMATS  │
  1164. └────────────────┘
  1165.  
  1166. Extensions  are  entirely managed by the program. If user gives
  1167. an  extension when asked for a filename, the program removes it
  1168. and puts the proper extension. Each type of file has its proper
  1169. extension.
  1170.  
  1171. SPR  Sprite table. Can hold relative addresses of sprites, or
  1172.      no.
  1173. WRK  Work file, it is created when saving sprites and it holds
  1174.      preferences, palette, board of automatons.
  1175. ADR  Addresses of sprites in the table. Generated by a CTRL-s.
  1176. PCX  Picture file, the standard format.
  1177. VRT  Picture file, more compressed format with fast display.
  1178. VGA  Picture file with no header, no compressed.
  1179. PAL  Palette. Bytes 0 to 767 are RGB registers, byte 768 is
  1180.      unused, bytes 769..784 for colors 0..15  of the VGA 18
  1181.       palette.
  1182. AUT  Automaton. Each sprite number use two bytes. Bytes 0 et 1
  1183.      of the file hold the number of sprites.
  1184. TRE  Tree file, holds 12 parameters, one byte each.
  1185. ICO  Standard Windows' (c) icon file.
  1186. ASC  Sprite saved as ASCII file.
  1187.  
  1188.  
  1189. ┌───────────────┐
  1190. │ COMPATIBILITY │
  1191. └───────────────┘
  1192.  
  1193. This  new  version  is  fully compatible with the previous ver-
  1194. sions.  However new variables for configuration have been added
  1195. since  version 1.6 to configuration (WRK) files, also some win-
  1196. dows  can  be black when loading old files. To fix that, change
  1197. colors with ALT-b and ALT-h and save the file.
  1198. Since  version  1.7  compatibility is full between Screen Maker
  1199. that produces 320 x 200 images and VTools.
  1200.  
  1201.  
  1202.